package displayboardinfo.messages;

import javax.xml.bind.annotation.XmlRootElement;

import displayboardinfo.entities.Visit;

/**
 * Żądnie do usługi zakończenia wizyty.
 * Zobacz również: {@link displayboardinfo.services.VisitsServices#finish(javax.xml.bind.JAXBElement)}}
 * 
 * @author Artur Jaworski
 */
@XmlRootElement
public class FinishVisitReq {
	private Visit visit;
	private boolean outOfQueue;
	
	/**
	 * Domyślny konstruktor bezargumentowy
	 */
	public FinishVisitReq(){
		outOfQueue = false;
	}
	
	/**
	 * Pobranie wizyty, którą należy zakończyć.
	 * 
	 * @return wizyta, którą należy zakończyć
	 */
	public Visit getVisit() {
		return visit;
	}
	
	/**
	 * Ustawinie wizyty, którą należy zakończyć.
	 * 
	 * @param visit wizyta, którą należy zakończyć
	 */
	public void setVisit(Visit visit) {
		this.visit = visit;
	}
	
	/**
	 * Pobranie informacji czy wizyta odbyła się "poza kolejką".
	 * Domyślnie parametr ustawiony na false.
	 * 
	 * @return czy wizyta odbyła się poza kolejnością
	 */
	public boolean isOutOfQueue() {
		return outOfQueue;
	}
	
	/**
	 * Ustawienie informacji czy wizyta odbyła się "poza kolejką".
	 * 
	 * @param outOfQueue czy wizyta odbyła się poza kolejnością
	 */
	public void setOutOfQueue(boolean outOfQueue) {
		this.outOfQueue = outOfQueue;
	}
}
